<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.math3.analysis.solvers;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    /** The kinds of solutions that a {@link BracketedUnivariateSolver<a name="line.21"></a>
<FONT color="green">022</FONT>     * (bracketed univariate real) root-finding algorithm} may accept as solutions.<a name="line.22"></a>
<FONT color="green">023</FONT>     * This basically controls whether or not under-approximations and<a name="line.23"></a>
<FONT color="green">024</FONT>     * over-approximations are allowed.<a name="line.24"></a>
<FONT color="green">025</FONT>     *<a name="line.25"></a>
<FONT color="green">026</FONT>     * &lt;p&gt;If all solutions are accepted ({@link #ANY_SIDE}), then the solution<a name="line.26"></a>
<FONT color="green">027</FONT>     * that the root-finding algorithm returns for a given root may be equal to the<a name="line.27"></a>
<FONT color="green">028</FONT>     * actual root, but it may also be an approximation that is slightly smaller<a name="line.28"></a>
<FONT color="green">029</FONT>     * or slightly larger than the actual root. Root-finding algorithms generally<a name="line.29"></a>
<FONT color="green">030</FONT>     * only guarantee that the returned solution is within the requested<a name="line.30"></a>
<FONT color="green">031</FONT>     * tolerances. In certain cases however, in particular for<a name="line.31"></a>
<FONT color="green">032</FONT>     * {@link org.apache.commons.math3.ode.events.EventHandler state events} of<a name="line.32"></a>
<FONT color="green">033</FONT>     * {@link org.apache.commons.math3.ode.ODEIntegrator ODE solvers}, it<a name="line.33"></a>
<FONT color="green">034</FONT>     * may be necessary to guarantee that a solution is returned that lies on a<a name="line.34"></a>
<FONT color="green">035</FONT>     * specific side the solution.&lt;/p&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     *<a name="line.36"></a>
<FONT color="green">037</FONT>     * @see BracketedUnivariateSolver<a name="line.37"></a>
<FONT color="green">038</FONT>     * @since 3.0<a name="line.38"></a>
<FONT color="green">039</FONT>     * @version $Id: AllowedSolution.java 1364387 2012-07-22 18:14:11Z tn $<a name="line.39"></a>
<FONT color="green">040</FONT>     */<a name="line.40"></a>
<FONT color="green">041</FONT>    public enum AllowedSolution {<a name="line.41"></a>
<FONT color="green">042</FONT>        /** There are no additional side restriction on the solutions for<a name="line.42"></a>
<FONT color="green">043</FONT>         * root-finding. That is, both under-approximations and over-approximations<a name="line.43"></a>
<FONT color="green">044</FONT>         * are allowed. So, if a function f(x) has a root at x = x0, then the<a name="line.44"></a>
<FONT color="green">045</FONT>         * root-finding result s may be smaller than x0, equal to x0, or greater<a name="line.45"></a>
<FONT color="green">046</FONT>         * than x0.<a name="line.46"></a>
<FONT color="green">047</FONT>         */<a name="line.47"></a>
<FONT color="green">048</FONT>        ANY_SIDE,<a name="line.48"></a>
<FONT color="green">049</FONT>    <a name="line.49"></a>
<FONT color="green">050</FONT>        /** Only solutions that are less than or equal to the actual root are<a name="line.50"></a>
<FONT color="green">051</FONT>         * acceptable as solutions for root-finding. In other words,<a name="line.51"></a>
<FONT color="green">052</FONT>         * over-approximations are not allowed. So, if a function f(x) has a root<a name="line.52"></a>
<FONT color="green">053</FONT>         * at x = x0, then the root-finding result s must satisfy s &amp;lt;= x0.<a name="line.53"></a>
<FONT color="green">054</FONT>         */<a name="line.54"></a>
<FONT color="green">055</FONT>        LEFT_SIDE,<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>        /** Only solutions that are greater than or equal to the actual root are<a name="line.57"></a>
<FONT color="green">058</FONT>         * acceptable as solutions for root-finding. In other words,<a name="line.58"></a>
<FONT color="green">059</FONT>         * under-approximations are not allowed. So, if a function f(x) has a root<a name="line.59"></a>
<FONT color="green">060</FONT>         * at x = x0, then the root-finding result s must satisfy s &amp;gt;= x0.<a name="line.60"></a>
<FONT color="green">061</FONT>         */<a name="line.61"></a>
<FONT color="green">062</FONT>        RIGHT_SIDE,<a name="line.62"></a>
<FONT color="green">063</FONT>    <a name="line.63"></a>
<FONT color="green">064</FONT>        /** Only solutions for which values are less than or equal to zero are<a name="line.64"></a>
<FONT color="green">065</FONT>         * acceptable as solutions for root-finding. So, if a function f(x) has<a name="line.65"></a>
<FONT color="green">066</FONT>         * a root at x = x0, then the root-finding result s must satisfy f(s) &amp;lt;= 0.<a name="line.66"></a>
<FONT color="green">067</FONT>         */<a name="line.67"></a>
<FONT color="green">068</FONT>        BELOW_SIDE,<a name="line.68"></a>
<FONT color="green">069</FONT>    <a name="line.69"></a>
<FONT color="green">070</FONT>        /** Only solutions for which values are greater than or equal to zero are<a name="line.70"></a>
<FONT color="green">071</FONT>         * acceptable as solutions for root-finding. So, if a function f(x) has<a name="line.71"></a>
<FONT color="green">072</FONT>         * a root at x = x0, then the root-finding result s must satisfy f(s) &amp;gt;= 0.<a name="line.72"></a>
<FONT color="green">073</FONT>         */<a name="line.73"></a>
<FONT color="green">074</FONT>        ABOVE_SIDE;<a name="line.74"></a>
<FONT color="green">075</FONT>    <a name="line.75"></a>
<FONT color="green">076</FONT>    }<a name="line.76"></a>




























































</PRE>
</BODY>
</HTML>
